Salesforce UX API
TMF678- listCustomer-V2
CASE 1 Unitary Test
This usecase is to retrieve bill history from evertec
URL
https://nonprod.esb.cloud.lla.com/dev/sfdc-ux/sfdc-ux/v2/PR/customerBillURI Param
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. Expected one is "PR"-Puerto Rico | Y |
Query Param
| name | type | description | required |
|---|---|---|---|
| billingAccount.id | string | customer account id | Y |
Header
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request | Y |
Request
curl --location 'https://nonprod.esb.cloud.lla.com/dev/sfdc-ux/sfdc-ux/v2/PR/customerBill?billingAccount.id=821470133' \
--header 'client_id: 784c9a6dd7ae49768816cab57fcf1fa1' \
--header 'client_secret: 187b259EB77441babbF611d2646C670d' \
--header 'X-Correlation-ID: 25486246478547854785'200 OK
Response
{
"href": "string", //objectUrl
"billDate": "2024-06-27T15:12:28.863Z", //cycleDate
"characteristics": [
{
"valueType": "Object",
"valueName": "billDetails",
"value": {
"viewed": "string",
"pageCount": "1",
"product": "string"
}
}
]
}Definitions
Each of the request parameters is detailed.
| name | type | description | required |
|---|---|---|---|
| href | string | url of the downloadable pdf | N |
| billDate | datetime | Bill date | N |
| characteristics.valueType | string | Type of the value | N |
| characteristics.valueName | string | Name of the value | N |
| characteristics.value | object | value of characteristic | N |
| characteristics.value.viewed | string | value to represent the status of view | N |
| characteristics.value.pageCount | string | page count of the pdf file | N |
| characteristics.value.product | string | product of the pdf file | N |